/*
 * Copyright 2008 the Breachwalls OSS project and the Others.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package com.breachwalls.mogen.generator;

import java.io.File;

/**
 * 自動生成設定を持つプロパティ.
 * @author todoken
 * @version $Revision: 31 $
 */
public interface ModelGenerationProperties {

    /**
     * 自動生成定義読み込みベースディレクトリを取得する.
     * @return 自動生成定義読み込みベースディレクトリ
     */
    File getBaseDirectory();

    /**
     * 自動生成ファイル出力先ディレクトリを取得する.
     * @return 自動生成ファイル出力先ディレクトリ
     */
    File getOutputDirectory();

    /**
     * 自動生成設定ファイルのあるディレクトリを取得する.
     * @return 自動生成設定ファイルのあるディレクトリ
     */
    File[] getConfigDirectories();

    /**
     * 出力ファイルの文字コードを取得する.
     * @return 出力ファイルの文字コード
     */
    String getOutputEncoding();

    /**
     * テンプレートファイルのロケーションを取得する.
     * @return テンプレートファイルのロケーション
     */
    File getTemplateLocation();

}
